SDK-2713-net-sdk-request-header #491
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds HTTP response header access functionality to the Yoti .NET SDK, enabling clients to retrieve headers including X-Request-ID for troubleshooting API connection issues while maintaining backward compatibility.
- Introduces
YotiHttpResponse<T>wrapper class to expose both response data and HTTP headers - Modifies existing API methods to return header information alongside response data
- Maintains backward compatibility through implicit conversion operators
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Yoti.Auth/Web/YotiHttpResponse.cs | New wrapper class providing access to HTTP response headers and data |
| src/Yoti.Auth/Web/Request.cs | Adds ExecuteWithHeaders method to support header extraction |
| src/Yoti.Auth/DigitalIdentity/DigitalIdentityService.cs | Implements header-aware versions of share session and receipt methods |
| src/Yoti.Auth/DigitalIdentityClient.cs | Updates client methods to return YotiHttpResponse wrapper |
| src/Yoti.Auth/DocScan/DocScanService.cs | Updates DocScan service methods to return headers |
| src/Yoti.Auth/DocScan/DocScanClient.cs | Updates DocScan client methods to return YotiHttpResponse wrapper |
| test/Yoti.Auth.Tests/Web/YotiHttpResponseTests.cs | Comprehensive test suite for the new YotiHttpResponse functionality |
| src/Yoti.Auth/Examples/RequestHeaderExample.cs | Example code demonstrating header access patterns |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| public async Task<GetSessionResult> GetSession(string sdkId, AsymmetricCipherKeyPair keyPair, string sessionId) | ||
| }).ConfigureAwait(false); | ||
| } public async Task<YotiHttpResponse<GetSessionResult>> GetSession(string sdkId, AsymmetricCipherKeyPair keyPair, string sessionId) |
There was a problem hiding this comment.
Missing line break between method declarations. There should be a proper line break between the closing brace of CreateSession and the start of GetSession method.
| .WithHttpMethod(HttpMethod.Post) | ||
| .WithBaseUri(ApiUri) | ||
| .WithEndpoint("/sessions") | ||
| .WithEndpoint("sessions") |
There was a problem hiding this comment.
The endpoint path should start with a forward slash. This change from '/sessions' to 'sessions' may cause incorrect URL construction.
Suggested change
| .WithEndpoint("sessions") | |
| .WithEndpoint("/sessions") |
| } | ||
|
|
||
| /// <summary> | ||
| } /// <summary> |
There was a problem hiding this comment.
Missing line break between method declarations. There should be a proper line break between the closing brace and the start of the comment block.
Comment on lines
344
to
351
| /// Gets a share receipt and returns the result with HTTP response headers | ||
| /// </summary> | ||
| public static async Task<YotiHttpResponse<SharedReceiptResponse>> GetShareReceiptWithHeaders(HttpClient httpClient, string clientSdkId, Uri apiUrl, AsymmetricCipherKeyPair key, string receiptId) | ||
| { | ||
| // For now, call the regular method and wrap the result with empty headers | ||
| // This is a simplified implementation - full header support would require modifying all the internal HTTP calls | ||
| var result = await GetShareReceipt(httpClient, clientSdkId, apiUrl, key, receiptId); | ||
| return YotiHttpResponse<SharedReceiptResponse>.FromHttpResponse(result, new HttpResponseMessage()); |
There was a problem hiding this comment.
Creating an empty HttpResponseMessage loses all header information. This implementation doesn't actually provide headers as promised by the method name. The method should be refactored to properly capture and return HTTP response headers.
Suggested change
| /// Gets a share receipt and returns the result with HTTP response headers | |
| /// </summary> | |
| public static async Task<YotiHttpResponse<SharedReceiptResponse>> GetShareReceiptWithHeaders(HttpClient httpClient, string clientSdkId, Uri apiUrl, AsymmetricCipherKeyPair key, string receiptId) | |
| { | |
| // For now, call the regular method and wrap the result with empty headers | |
| // This is a simplified implementation - full header support would require modifying all the internal HTTP calls | |
| var result = await GetShareReceipt(httpClient, clientSdkId, apiUrl, key, receiptId); | |
| return YotiHttpResponse<SharedReceiptResponse>.FromHttpResponse(result, new HttpResponseMessage()); | |
| /// Gets a share receipt and returns the result and the HTTP response message | |
| /// </summary> | |
| private static async Task<(SharedReceiptResponse, HttpResponseMessage)> GetShareReceiptWithHttpResponse(HttpClient httpClient, string clientSdkId, Uri apiUrl, AsymmetricCipherKeyPair key, string receiptId) | |
| { | |
| Validation.NotNull(httpClient, nameof(httpClient)); | |
| Validation.NotNull(apiUrl, nameof(apiUrl)); | |
| Validation.NotNull(clientSdkId, nameof(clientSdkId)); | |
| Validation.NotNull(key, nameof(key)); | |
| string endpoint = string.Format(shareReceiptRetrieval, receiptId); | |
| Request shareReceiptRequest = new RequestBuilder() | |
| .WithKeyPair(key) | |
| .WithBaseUri(apiUrl) | |
| .WithHeader(yotiAuthId, clientSdkId) | |
| .WithEndpoint(endpoint) | |
| .WithHttpMethod(HttpMethod.Get) | |
| .Build(); | |
| HttpResponseMessage response = await shareReceiptRequest.Execute(httpClient).ConfigureAwait(false); | |
| try | |
| { | |
| if (!response.IsSuccessStatusCode) | |
| { | |
| Response.CreateYotiExceptionFromStatusCode<DigitalIdentityException>(response); | |
| } | |
| var responseObject = await response.Content.ReadAsStringAsync(); | |
| var deserialized = await Task.Factory.StartNew(() => JsonConvert.DeserializeObject<SharedReceiptResponse>(responseObject)); | |
| return (deserialized, response); | |
| } | |
| catch | |
| { | |
| response.Dispose(); | |
| throw; | |
| } | |
| } | |
| /// <summary> | |
| /// Gets a share receipt and returns the result with HTTP response headers | |
| /// </summary> | |
| public static async Task<YotiHttpResponse<SharedReceiptResponse>> GetShareReceiptWithHeaders(HttpClient httpClient, string clientSdkId, Uri apiUrl, AsymmetricCipherKeyPair key, string receiptId) | |
| { | |
| // Call the overload that returns both the result and the HttpResponseMessage | |
| var (result, responseMessage) = await GetShareReceiptWithHttpResponse(httpClient, clientSdkId, apiUrl, key, receiptId); | |
| return YotiHttpResponse<SharedReceiptResponse>.FromHttpResponse(result, responseMessage); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability to access HTTP response headers (including X-Request-ID) from API calls in the Yoti .NET SDK, addressing client troubleshooting needs for connection timeout issues while maintaining full backward compatibility.